widget: Document signal mnemonic-activate

Name the extra bool argument, and move the explanatory paragraph from
the emitting method to the signal, with some minor tweaks to wording.

https://bugzilla.gnome.org/show_bug.cgi?id=778534

diff --git a/gtk/gtkwidget.c b/gtk/gtkwidget.c
index 85215f8c9f890182728db9724e26511806edd0aa..5e406a5d6fe9e2fa40c6005c7f8c74f27fbcc870 100644 (file)
--- a/gtk/gtkwidget.c
+++ b/gtk/gtkwidget.c
@@ -1832,7 +1832,10 @@ gtk_widget_class_init (GtkWidgetClass *klass)
   /**
    * GtkWidget::mnemonic-activate:
    * @widget: the object which received the signal.
-   * @arg1:
+   * @group_cycling: %TRUE if there are other widgets with the same mnemonic
+   *
+   * The default handler for this signal activates @widget if @group_cycling
+   * is %FALSE, or just makes @widget grab focus if @group_cycling is %TRUE.
    *
    * Returns: %TRUE to stop other handlers from being invoked for the event.
    * %FALSE to propagate the event further.
@@ -6205,14 +6208,10 @@ _gtk_widget_get_accel_path (GtkWidget *widget,
 /**
  * gtk_widget_mnemonic_activate:
  * @widget: a #GtkWidget
- * @group_cycling:  %TRUE if there are other widgets with the same mnemonic
+ * @group_cycling: %TRUE if there are other widgets with the same mnemonic
  *
  * Emits the #GtkWidget::mnemonic-activate signal.
  *
- * The default handler for this signal activates the @widget if
- * @group_cycling is %FALSE, and just grabs the focus if @group_cycling
- * is %TRUE.
- *
  * Returns: %TRUE if the signal has been handled
  */
 gboolean